Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

vdiff: factor Summarize out from vtctldclient #16781

Closed
wants to merge 1 commit into from
Closed

vdiff: factor Summarize out from vtctldclient #16781

wants to merge 1 commit into from

Conversation

mdlayher
Copy link
Member

@mdlayher mdlayher commented Sep 13, 2024 •
edited by mattlord
Loading

Description

Factor out buildSingleSummary as vdiff.Summarize, which generates a summary of the VDiff operation based on the VDiffShow RPC response.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

@mdlayher
vdiff: factor Summarize out from vtctldclient
a77b4af 
Factor out buildSingleSummary as vdiff.Summarize, which generates a summary of
the VDiff operation based on the VDiffShow RPC response.

Fixes #16780.

Signed-off-by: Matt Layher <[email protected]>
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Sep 13, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Sep 13, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 13, 2024
@codecov Codecov
Copy link

codecov bot commented Sep 13, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 75.57252% with 32 lines in your changes missing coverage. Please review.

Project coverage is 68.95%. Comparing base (155ede0) to head (a77b4af).
Report is 212 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vttablet/tabletmanager/vdiff/summary.go 75.38% 32 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #16781      +/-   ##
==========================================
+ Coverage   68.93%   68.95%   +0.02%     
==========================================
  Files        1565     1566       +1     
  Lines      201764   201764              
==========================================
+ Hits       139088   139129      +41     
+ Misses      62676    62635      -41

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mdlayher
mdlayher commented Sep 13, 2024
View reviewed changes
go/cmd/vtctldclient/command/vreplication/vdiff/vdiff.go
@@ -438,7 +408,7 @@ HasMismatch: {{.HasMismatch}}
StartedAt: {{.StartedAt}}
{{if (eq .State "started")}}Progress: {{printf "%.2f" .Progress.Percentage}}%%{{if .Progress.ETA}}, ETA: {{.Progress.ETA}}{{end}}{{end}}
{{if .CompletedAt}}CompletedAt: {{.CompletedAt}}{{end}}
{{range $table := .TableSummaryMap}}
{{range $table := .TableSummaryMap}}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small bit of trailing whitespace here and on line 420. I suspect it's not load bearing but if it turns out to be, I can undo this.

@mattlord mattlord added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication and removed NeedsIssue A linked issue is missing for this Pull Request NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Sep 13, 2024
@mattlord
Copy link
Contributor

@mdlayher I like this idea! Makes total sense to me. I don't, however, think that tabletmanager is the right place for this code as it's really VtctldServer code that's working with vtctldata protos (rather than TabletManager code working with tabletmanagerdata protos), which primarily lives in the workflow package (go/vt/vtctl/workflow). I think we should probably create a go/vt/vtctl/workflow/vdiff.go file and move this code there along with the other VDiff functions that are currently in workflow/server.go — we need to start splitting that file up anyway as it's getting massive. That make sense?

@vitess-bot vitess-bot modified the milestones: v21.0.0, v22.0.0 Oct 8, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 8, 2024

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. and removed Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. labels Nov 8, 2024
@deepthi
Copy link
Member

deepthi commented Dec 8, 2024

Closing as stale. Please re-open if you would like to address review feedback.

@deepthi deepthi closed this Dec 8, 2024
@mdlayher
Copy link
Member Author

mdlayher commented Dec 9, 2024

Thanks! I owe a new PR with a different approach.

@mdlayher mdlayher deleted the mdl-vdiff-summarize branch December 9, 2024 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 is a code owner

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps is a code owner

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

Assignees
No one assigned
Labels
Component: VReplication Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.

Feature Request: export vtctldclient VDiffShow summarization code
4 participants
@mdlayher @mattlord @deepthi @vitess-bot